Revise CSS node documentation
authorMatthias Clasen <mclasen@redhat.com>
Wed, 16 Dec 2015 15:55:52 +0000 (10:55 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Wed, 16 Dec 2015 15:58:47 +0000 (10:58 -0500)
Clarify the use of brackets in the CSS node diagrams:
[] means optional nodes or classes, <> means child widgets.

16 files changed:
gtk/gtkcheckbutton.c
gtk/gtkcheckmenuitem.c
gtk/gtkexpander.c
gtk/gtkflowbox.c
gtk/gtkgrid.c
gtk/gtklevelbar.c
gtk/gtkmenu.c
gtk/gtkmenuitem.c
gtk/gtkmodelbutton.c
gtk/gtknotebook.c
gtk/gtkpaned.c
gtk/gtkradiobutton.c
gtk/gtkradiomenuitem.c
gtk/gtkscale.c
gtk/gtktreeview.c
gtk/gtkwindow.c

index 932469e48a273087d5501941ab3c16e1f0489f98..471543aa594e6d63ed1c39465824704354de6489 100644 (file)
@@ -57,7 +57,8 @@
  *
  * |[<!-- language="plain" -->
  * checkbutton
- * ╰── check
+ * ├── check
+ * ╰── <child>
  * ]|
  *
  * A GtkCheckButton with indicator (see gtk_toggle_button_set_mode()) has a
@@ -65,7 +66,8 @@
  *
  * |[<!-- language="plain" -->
  * button.check
- * ╰── [check]
+ * ├── check
+ * ╰── <child>
  * ]|
  *
  * A GtkCheckButton without indicator changes the name of its main node
index d8654a9d8e2a7be1e8ddbb313639df38c8300f97..aaf830402bff9495ac1161f7dedcc284e562fe70 100644 (file)
@@ -53,8 +53,8 @@
  *
  * |[<!-- language="plain" -->
  * menuitem
- * ├── ...
- * ╰── check.right
+ * ├── check.left
+ * ╰── <child>
  * ]|
  *
  * GtkCheckMenuItem has a main CSS node with name menuitem, and a subnode
index 0c32ff2a08480eb1c88d13db5c18a659e0204b6a..e3d3291e94181a2500c58543cc177e68249ab0f4 100644 (file)
@@ -94,8 +94,8 @@
  * expander
  * ├── title
  * │   ├── arrow
- * │   ╰── label widget
- * ╰── child
+ * │   ╰── <label widget>
+ * ╰── <child>
  * ]|
  *
  * GtkExpander has three CSS nodes, the main node with the name expander,
index 018804dd745299961b86807e308da6cea5788a97..358321976e98793451552b62e73a97327f0b0300 100644 (file)
@@ -57,9 +57,9 @@
  * |[<!-- language="plain" -->
  * flowbox
  * ├── flowboxchild
- * │   ╰── child
+ * │   ╰── <child>
  * ├── flowboxchild
- * │   ╰── child
+ * │   ╰── <child>
  * ┊
  * ╰── [rubberband]
  * ]|
index 50edea7ce8d2fce1669fba187025285a9edffc31..5fed33fe2d9d3f92a19aebaddb11a5c301847d9e 100644 (file)
@@ -55,7 +55,7 @@
  *
  * # CSS nodes
  *
- * GtkGrid uses a single CSS node wiht name grid.
+ * GtkGrid uses a single CSS node with name grid.
  */
 
 typedef struct _GtkGridChild GtkGridChild;
index 2477d12ba65e88fb8f831544150d623a862e3742..45d9d4a0c68be69c554e6c344d1e112fd5e4feb3 100644 (file)
@@ -89,7 +89,7 @@
  * |[<!-- language="plain" -->
  * levelbar[.discrete]
  * ╰── trough
- *     ├── block.filled.<level-name>
+ *     ├── block.filled.level-name
  *     ┊
  *     ├── block.empty
  *     ┊
  * trough node are a number of nodes with name block and style class .filled
  * or .empty. In continuous mode, there is exactly one node of each, in discrete
  * mode, the number of filled and unfilled nodes corresponds to blocks that are
- * drawn. The block.filled nodes also get a style class .<level-name> corresponding
+ * drawn. The block.filled nodes also get a style class .level-name corresponding
  * to the level for the current value.
  */
 #include "config.h"
index 78ff677744d56614ae926befb37decedf067c9b1..fa7eda752d9c03579dd4d83da6695a7ebff7d6ff 100644 (file)
@@ -88,7 +88,9 @@
  * |[<!-- language="plain" -->
  * menu
  * ├── arrow.top
- * ├── ...
+ * ├── <child>
+ * ┊
+ * ├── <child>
  * ╰── arrow.bottom
  * ]|
  *
index 252b93ca8db3f4c462a305803d9459b18984fd8f..c29c30c12c02abfdec083cbb52a08376a57d906f 100644 (file)
@@ -92,7 +92,7 @@
  *
  * |[<!-- language="plain" -->
  * menuitem
- * ├── ...
+ * ├── <child>
  * ╰── [arrow.right]
  * ]|
  *
index 0cbdbbe76aab32f643ca3a3e8cbb09f930ad046a..727ea67f6ce415cf017cad0829150bb2cc2e844b 100644 (file)
  *
  * |[<!-- language="plain" -->
  * modelbutton
- * ├── ...
+ * ├── <child>
  * ╰── check
  * ]|
  *
  * |[<!-- language="plain" -->
  * modelbutton
- * ├── ...
+ * ├── <child>
  * ╰── radio
  * ]|
  *
  * |[<!-- language="plain" -->
  * modelbutton
- * ├── ...
+ * ├── <child>
  * ╰── arrow
  * ]|
  *
index 6dddcb8f1ea8c47d1d492ff3248749af0d4b55c5..5d27c6c4a175a8f9b8c431e27fa7de01d8babc79 100644 (file)
  * |[<!-- language="plain" -->
  * notebook
  * ├── header.top
- * │   ├── [action widget]
+ * │   ├── [<action widget>]
  * │   ├── tabs
  * │   │   ├── [arrow]
  * │   │   ├── tab
- * ┊   ┊   ┊   ╰── [tab label]
+ * │   │   │   ╰── <tab label>
+ * ┊   ┊   ┊
  * │   │   ├── tab[.reorderable-page]
- * │   │   │   ╰── [tab label]
+ * │   │   │   ╰── <tab label>
  * │   │   ╰── [arrow]
- * │   ╰── [action widget]
+ * │   ╰── [<action widget>]
  * │
- * ├── [child]
+ * ├── <child>
  * ┊
- * ╰── [child]
+ * ╰── <child>
  * ]|
  *
  * GtkNotebook has a main CSS node with name notebook, a subnode
index 531f5f0c70cf812974eb289ef1c5b32cbbcd944c..dfab414f1d3de03681e9ed877cd076380131b8f3 100644 (file)
@@ -85,7 +85,9 @@
  *
  * |[<!-- language="plain" -->
  * paned
- * ╰── separator[.wide]
+ * ├── <child>
+ * ├── separator[.wide]
+ * ╰── <child>
  * ]|
  *
  * GtkPaned has a main CSS node with name paned, and a subnode for
index 53191a48cfa869934bbc3e403808297bafe4842d..59ca75cf919aea90a8a1ae0f7daaff97829dec51 100644 (file)
@@ -76,7 +76,8 @@
  *
  * |[<!-- language="plain" -->
  * radiobutton
- * ╰── radio
+ * ├── radio
+ * ╰── <child>
  * ]|
  *
  * A GtkRadioButton with indicator (see gtk_toggle_button_set_mode()) has a
@@ -84,7 +85,8 @@
  *
  * |[<!-- language="plain" -->
  * button.radio
- * ╰── [radio]
+ * ├── radio
+ * ╰── <child>
  * ]|
  *
  * A GtkRadioButton without indicator changes the name of its main node
index 919b8473f83f4df1629c1c35ae48202b77531a56..ee70dd70ca17c81deb919859499c90215e31b795 100644 (file)
@@ -66,8 +66,8 @@
  *
  * |[<!-- language="plain" -->
  * menuitem
- * ├── ...
- * ╰── radio
+ * ├── radio.left
+ * ╰── <child>
  * ]|
  *
  * GtkRadioMenuItem has a main CSS node with name menuitem, and a subnode
index 07a7a61efec0bbd37d29322c35f53c4ee0d44857..364b27f4c24997f55dd22a68924c6e0d2cdc8b6f 100644 (file)
  * scale[.fine-tune]
  * ├── marks.top
  * │   ├── mark
- * â\94\82   â\94\9câ\94\80â\94\80 mark
- * │   ╰── ...
+ * â\94\8a   â\94\8a
+ * │   ╰── mark
  * ├── trough
- * │   ├──slider
+ * │   ├── slider
  * │   ├── [highlight]
  * │   ╰── [fill]
  * ╰── marks.bottom
  *     ├── mark
- *     â\94\9câ\94\80â\94\80 mark
- *     ╰── ...
+ *     â\94\8a
+ *     ╰── mark
  * ]|
  *
  * GtkScale has a main CSS node with name scale, and subnodes with names
index 06924eb8183bc7d6203633853dd2a1b4cc4b540e..7e2f0277a99d90e281f88956e40533a0d84c9406 100644 (file)
  * |[<!-- language="plain" -->
  * treeview.view
  * ├── header
- * │   ├── [column header]
- * â\94\82   â\94\9câ\94\80â\94\80 [column header]
-   ┊   ┊
+ * │   ├── <column header>
+ * â\94\8a   â\94\8a
+ * │   ╰── <column header>
  * │
  * ╰── [rubberband]
  * ]|
index 3580daf653b9820642eb0d76a6fa9eb908201806..802904c8d066cac9808febb26786eeb88d2613b8 100644 (file)
  *
  * |[<!-- language="plain" -->
  * window
- * ╰── decoration
+ * ├── decoration
+ * ╰── <child>
  * ]|
  *
  * GtkWindow has a main CSS node with name window and style class .background,